11.4 Add Request Lock Event

In This Topic

After determining that the lock can be extended, create an addLockEvent call.

Create a lockExtender object in the body of the call. See the Body section below for details.

The call creates an extension request that will be accepted or rejected.

Path

/rest/v1/lp-ppe-api/price-quote/addLockEvent

Headers

secret

companyid

Path Parameters

There are no path parameters.

Body

In the body of the call, include the following information:

a lockExtender object with the following attributes to extend the lock:
- an "enable" value of "true"
- a "type" value of "Request",
- a lockExtensions array containing the details of the extension,
- any other values you wish to set.

You do not need to populate the "creationDate" or "modifiedDate" fields; these will be programmatically populated as a time stamp. If you are modifying a previous request, populate the "id" field for the LockExtender object; otherwise leave the field blank and the lockExtender will be generated by the system.

Example Request

	Copy Code
"lockExtender": { "id": "5bec8a27671267199356e283", "mergeSet": null, "createdBy": null, "creationDate": "2018-11-14T20:48:39Z", "modifiedBy": null, "modifiedDate": "2018-11-14T20:48:39Z", "enable": false, "type": "Request", "useRateProgram": true, "allowOverride": false, "lockExtensions": [], "allowDailyFee": false, "dailyFeeAmount": null, "comment": null }

Copy Code

"lockExtender": {
"id": "5bec8a27671267199356e283",
"mergeSet": null,
"createdBy": null,
"creationDate": "2018-11-14T20:48:39Z",
"modifiedBy": null,
"modifiedDate": "2018-11-14T20:48:39Z",
"enable": false,
"type": "Request",
"useRateProgram": true,
"allowOverride": false,
"lockExtensions": [],
"allowDailyFee": false,
"dailyFeeAmount": null,
"comment": null
    }

	Copy Code

Response

The call returns no body.